<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>prd: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">prd
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">prd Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The Xilinx Partial Reconfiguration Decoupler driver can be used to provide a boundary between the static logic and a Reconfigurable Partition during Partial Reconfiguration.The PR Decoupler supports the following features:</p><ul>
<li>All Interface types registered in the Vivado Design Suite are supported, including custom interfaces.</li>
<li>Non-Vivado Design Suite interfaces are supported.</li>
<li>The decoupling behaviour can be configured for each interface.</li>
<li>Each interface can have Clock Domain Crossing support.</li>
<li>Optional AXI4-Stream based control.</li>
<li>Optional AXI4-Stream based Status.</li>
<li>Optional AXI4-Lite based status and control.</li>
</ul>
<p><b> Initialization and Configuration </b></p>
<ul>
<li>XPrd_LookupConfig(DeviceId) - Use the device identifier to find the static configuration structure defined in xprd_g.c. This is setup by the tools. For some operating systems the config structure will be initialized by the software and this call is not needed.</li>
<li><a class="el" href="group__prd__v1__0.html#ga424f5c8b2cad657a5aea953ba959be55" title="This function initializes a XPrd instance/driver. ">XPrd_CfgInitialize()</a> is used for initialisation. The user needs to first call the <a class="el" href="group__prd__v1__0.html#ga7a83aa6940de765c091dfd07df308ac2" title="This function looks for the device configuration based on the unique device ID. ">XPrd_LookupConfig()</a> which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="group__prd__v1__0.html#ga424f5c8b2cad657a5aea953ba959be55" title="This function initializes a XPrd instance/driver. ">XPrd_CfgInitialize()</a>.</li>
</ul>
<p><b> Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b> Asserts </b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.</p>
<p><b> Building the driver </b></p>
<p>The <a class="el" href="struct_x_prd.html" title="The XPrd instance data structure. ">XPrd</a> driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.</p>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who     Date          Changes
<hr/>

1.0   ms     07/14/16      First release
1.1   ms     01/16/17      Updated the parameter naming from
                           XPAR_PR_DECOUPLER_NUM_INSTANCES to
                           XPAR_XPRD_NUM_INSTANCES to avoid compilation
                           failure for XPAR_PR_DECOUPLER_NUM_INSTANCES as the
                           tools are generating XPAR_XPRD_NUM_INSTANCES
                           in the generated xprd_g.c for fixing MISRA-C
                           files. This is a fix for CR-966099 based on the
                           update in the tools.
      ms     03/17/17      Added readme.txt file in examples folder for
                           doxygen generation.</pre><pre></pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
